<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>jld.api</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="jld-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="jld-module.html">Package&nbsp;jld</a> ::
        Package&nbsp;api
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="jld.api-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package api</h1><p class="nomargin-top"><span class="codelink"><a href="jld.api-pysrc.html">source&nbsp;code</a></span></p>
<p>API tools</p>

<hr />
<div class="fields">      <p><strong>Author:</strong>
        Jean-Lou Dupont
      </p>
      <p><strong>Version:</strong>
        $Id: jld.api-module.html 733 2008-12-11 19:21:17Z jeanlou.dupont $
      </p>
</div><!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Submodules</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Submodules"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="jld.api.delicious-module.html">jld.api.delicious</a></strong>: <em class="summary">Delicious API</em>    </li>
    <li> <strong class="uidlink"><a href="jld.api.delicious_objects-module.html">jld.api.delicious_objects</a></strong>: <em class="summary">Delicious objects</em>    </li>
    <li> <strong class="uidlink"><a href="jld.api.mindmeister-module.html">jld.api.mindmeister</a></strong>: <em class="summary">MindMeister WEB Service API</em>    </li>
    <li> <strong class="uidlink"><a href="jld.api.mindmeister_response-module.html">jld.api.mindmeister_response</a></strong>: <em class="summary">MindMeister WEB Service API Change List:</em>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorAccess-class.html" class="summary-name">ErrorAccess</a><br />
      Generic Access error eg  restricted access
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorAuth-class.html" class="summary-name">ErrorAuth</a><br />
      Generic Authentication error
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorConfig-class.html" class="summary-name">ErrorConfig</a><br />
      Generic configuration error eg  can't load configuration from 
        filesystem
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorDaemon-class.html" class="summary-name">ErrorDaemon</a><br />
      Generic daemon error eg  can't os.fork
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorDb-class.html" class="summary-name">ErrorDb</a><br />
      Generic Db error eg  can't open database file
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorFile-class.html" class="summary-name">ErrorFile</a><br />
      Generic filesystem error eg  can't write to filepath
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorGeneric-class.html" class="summary-name">ErrorGeneric</a><br />
      Exception base class which accept parameters.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorInvalidCommand-class.html" class="summary-name">ErrorInvalidCommand</a><br />
      Generic command error eg  invalid command from cmd-line utility
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorMethod-class.html" class="summary-name">ErrorMethod</a><br />
      Generic method error eg  unavailable method for API end-point etc.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorNetwork-class.html" class="summary-name">ErrorNetwork</a><br />
      Error at the network layer eg  DNS error, no connection etc.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorObject-class.html" class="summary-name">ErrorObject</a><br />
      Generic object error eg  object not found
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorProperty-class.html" class="summary-name">ErrorProperty</a><br />
      Generic property error eg  feature X not available
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorProtocol-class.html" class="summary-name">ErrorProtocol</a><br />
      Generic protocol error eg  expecting parameter X but not found
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="jld.api.ErrorValidation-class.html" class="summary-name">ErrorValidation</a><br />
      Generic validation error eg  invalid parameter
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.api-module.html#alphaOrderParams" class="summary-sig-name">alphaOrderParams</a>(<span class="summary-sig-arg">liste</span>)</span><br />
      Orders a dictionary based parameters list by alphabetical key order.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.api-pysrc.html#alphaOrderParams">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.api-module.html#concatenateParams" class="summary-sig-name">concatenateParams</a>(<span class="summary-sig-arg">liste</span>)</span><br />
      Concatenates list of tuples of the form (key,value) into the form 
      <i>key=value</i></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.api-pysrc.html#concatenateParams">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.api-module.html#formatParams" class="summary-sig-name">formatParams</a>(<span class="summary-sig-arg">liste</span>)</span><br />
      Formats the parameters list for usage in an HTTP method.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.api-pysrc.html#formatParams">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.api-module.html#makeList" class="summary-sig-name">makeList</a>(<span class="summary-sig-arg">liste</span>)</span><br />
      Makes an url encoded list item1+item2+...</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.api-pysrc.html#makeList">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="jld.api-module.html#versaUrlEncode" class="summary-sig-name">versaUrlEncode</a>(<span class="summary-sig-arg">liste</span>,
        <span class="summary-sig-arg">RemoveNone</span>=<span class="summary-sig-default">False</span>)</span><br />
      Versatile URL encoder.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="jld.api-pysrc.html#versaUrlEncode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="StringTypes"></a><span class="summary-name">StringTypes</span> = <code title="(&lt;type 'str'&gt;, &lt;type 'unicode'&gt;)"><code class="variable-group">(</code>&lt;type 'str'&gt;<code class="variable-op">, </code>&lt;type 'unicode'&gt;<code class="variable-group">)</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__author__"></a><span class="summary-name">__author__</span> = <code title="'Jean-Lou Dupont'"><code class="variable-quote">'</code><code class="variable-string">Jean-Lou Dupont</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__dependencies__"></a><span class="summary-name">__dependencies__</span> = <code title="[]"><code class="variable-group">[</code><code class="variable-group">]</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="alphaOrderParams"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">alphaOrderParams</span>(<span class="sig-arg">liste</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.api-pysrc.html#alphaOrderParams">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Orders a dictionary based parameters list by alphabetical key 
  order.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>liste</code></strong> - input dictionary</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>the resulting list</dd>
  </dl>
</td></tr></table>
</div>
<a name="concatenateParams"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">concatenateParams</span>(<span class="sig-arg">liste</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.api-pysrc.html#concatenateParams">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Concatenates list of tuples of the form (key,value) into the form 
  <i>key=value</i></p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>liste</code></strong> - input list of tuples(key,value)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="formatParams"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">formatParams</span>(<span class="sig-arg">liste</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.api-pysrc.html#formatParams">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Formats the parameters list for usage in an HTTP method. Performs URI 
  encoding.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="makeList"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">makeList</span>(<span class="sig-arg">liste</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.api-pysrc.html#makeList">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Makes an url encoded list item1+item2+...</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>liste</code></strong> - input item list</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>string of the form <i>item1+item2+...</i></dd>
  </dl>
</td></tr></table>
</div>
<a name="versaUrlEncode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">versaUrlEncode</span>(<span class="sig-arg">liste</span>,
        <span class="sig-arg">RemoveNone</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="jld.api-pysrc.html#versaUrlEncode">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Versatile URL encoder. Handles the following cases:</p>
  <ol start="1">
    <li>
      list of key
    </li>
    <li>
      list of tuple (key,value)
    </li>
    <li>
      list of tuple (key, [values])
    </li>
    <li>
      dictionary of the form { 'key1': 'value1', 'key2':['v1', 'v2'] , 
      'some_key':None }
    </li>
  </ol>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>RemoveNone</code></strong> - affects 'some_key' in the use case #4 above</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>url encoded string</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="jld-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Dec 11 14:16:25 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
